JBoss.orgCommunity Documentation

Chapter 3. Installation and Running

3.1. Installing
3.1.1. Binary
3.2. Installing Mobicents SS7 Service Binary
3.3. Running Mobicents SS7 Service
3.3.1. Starting
3.3.2. Stopping
3.4. Configuring Mobicents SS7 Service
3.4.1. Configuring Remote Signaling Gateway
3.4.2. Configuring LinksetFactory
3.4.3. Configuring LinksetManager
3.4.4. Configuring ShellExecutor
3.4.5. Configuring SS7Service
3.5. Installing Mobicents Signaling Gateway Binary
3.6. Running Mobicents Signaling Gateway
3.6.1. Starting Mobicents Signaling Gateway
3.6.2. Start the Gateway With Alternate Configuration
3.6.3. Stopping
3.7. Configuring Mobicents Signaling Gateway
3.7.1. Configuring Signaling Gateway Process
3.7.2. Configuring LinksetFactory
3.7.3. Configuring LinksetManager
3.7.4. Configuring ShellExecutor
3.7.5. Configuring SignalingGateway
3.8. Setup from source
3.8.1. Release Source Code Building
3.8.2. Development Trunk Source Building

Mobicents SS7 stack at its core requires only Java if you are using only M3UALinkset. However if you plan to use DahdiLinkset or DialogicLinkset, respective SS7 cards needs to be installed on the server along with native libraries.

A simple way to get started is to download and install binary. This will provide you with all the dependencies you need to get going. You can obtain binary release from http://sourceforge.net/projects/mobicents/files

The Mobicents SS7 Stack binary is broken down into a few modules.

The following is a description of the important services and libraries that make up Mobicents SS7 Stack

Binary release has following layout:

The upper layers of Mobicents SS7 viz., TCAP, MAP depends on Mobicents SS7 Service and Mobicents SS7 Service must be installed before upper layers can be used. The Mobicents SS7 Service binary requires that you have JBoss Application Server installed and JBOSS_HOME system property set. To know further details on setting JBOSS_HOME look Appendix B, Setting the JBOSS_HOME Environment Variable

Once JBOSS_HOME is properly set, use ant to deploy the mobicents-ss7-service, shell scripts and shell library.

Important

Ant 1.6 (or higher) is used to install the binary. Instructions for using Ant, including install, can be found at http://ant.apache.org/

[usr]$ cd ss7-1.0.0.BETA8/ss7
[usr]$ ant deploy
			

To undeploy these services

[usr]$ cd ss7-1.0.0.BETA8/ss7
[usr]$ ant undeploy
			

While above steps will deploy the necessary ss7 service and shell components, the java.library.path should be set to point the directory containing native component or should be copied to JBoss native library path manually. This step is only required if you are using the SS7 board on server.

Starting or stopping Mobicents SS7 Service is no different than starting or stopping JBoss Application Server

Once installed, you can run server by executing the run.sh (Unix) or run.bat (Microsoft Windows) startup scripts in the <install_directory>/bin directory (on Unix or Windows). If the service started properly you should see following lines in the Unix terminal or Command Prompt depending on your environment:

23:22:26,079 INFO  [LinksetManager] SS7 configuration file path /home/abhayani/workarea/mobicents/jboss-5.1.0.GA/server/default/data/linksetmanager.xml
23:22:26,141 INFO  [LinksetManager] Started LinksetManager
23:22:26,199 INFO  [SS7Service] Starting SCCP stack...
23:22:26,229 INFO  [SccpStackImpl] Starting ...
23:22:26,230 INFO  [RouterImpl] SCCP Router configuration file: /home/abhayani/workarea/mobicents/jboss-5.1.0.GA/server/default/deploy/mobicents-ss7-service/sccp-routing.txt
23:22:26,261 INFO  [SS7Service] SCCP stack Started. SccpProvider bound to java:/mobicents/ss7/sccp
23:22:26,261 INFO  [ShellExecutor] Starting SS7 management shell environment
23:22:26,270 INFO  [ShellExecutor] ShellExecutor listening at /127.0.0.1:3435
23:22:26,270 INFO  [SS7Service] [[[[[[[[[ Mobicents SS7 service started ]]]]]]]]]

				

If you have started ss7-1.0.0.BETA8 for the first time, there are no Linkset defined. You need to use Shell Client to connect to ss7-1.0.0.BETA8 as defined in Chapter 5, Shell Command Line and create Linkset as per your need and SS7 card installed

Once the Linkset are defined, the state and configuration of Linkset and Link is persisted by LinksetManager which stands server re-start.

Configuration is done through an XML descriptor named jboss-beans.xml and is located at $JBOSS_HOME/server/profile_name/deploy/mobicents-ss7-service/META-INF, where profile_name is the server profile name.

Remote Signaling Gateway is only needed if the underlying SS7 service will leverage M3UALinkset. RemSgpImpl acts as remote Signaling Gateway Process that contains the list of Application Server (AS) (and list of Application Server Process (ASP) within each AS) connecting to external Signaling Gateway (SG). M3UAShellExecutor accepts the M3UA commands and executes necessary operations. RemSignalingGateway manages the remote SGP.



    <!-- ================================================ -->
    <!-- Remote Signalling Gateway Service                -->
    <!-- ================================================ -->
    <!--
          | Beans RemSgpImpl, M3UAShellExecutor and RemSignalingGateway defined bellow are only 
          | needed if M3UALinkset will be used to connect to external Signaling Gateway. Delete/Comment 
          | out these beans if hardware is installed in same machine where 
          | mobicents-ss7-service is running.
    -->
    <bean name="RemSgpImpl"
        class="org.mobicents.protocols.ss7.m3ua.impl.as.RemSgpImpl">
    </bean>

    <bean name="M3UAShellExecutor"
        class="org.mobicents.protocols.ss7.m3ua.impl.oam.M3UAShellExecutor">
        <property name="sgp">
            <inject bean="RemSgpImpl" />
        </property>
    </bean>

    <!-- Define Remote Signalling Gateway-->
    <bean name="RemSignalingGateway"
        class="org.mobicents.ss7.RemSignalingGateway">
        <property name="remSgpImpl">
            <inject bean="RemSgpImpl" />
        </property>
    </bean>
                        

Concrete implementation of LinksetFactory is responsible to create new instances of corresponding Linkset when instructed by LinksetManager. Mobicents SS7 Stack defined three linkset factories :

Its highly unlikely that you would require all three factories on same server. If you have dahdi based SS7 card installed, keep DahdiLinksetFactory and remove other two. If you have dialogic based SS7 card installed, keep DialogicLinksetFactory and remove other two. If you don't have any hardware installed and depend on M3UA, keep M3UALinksetFactory and remove other two. Nevertheless you can still use above factories in any combinations.

LinksetFactoryFactory is just a call-back class listening for new factories deployed and maintains Map of available factory name vs factory. You should never touch this bean.

ShellExecutor is responsible for listening to incoming command. Received commands are executed on local resources to perform actions like creation and management of SCCP routing rule, creation and management of Linkset, management of M3UA stack.


<!-- ================================================ -->
    <!-- Shell Service                                                        -->
    <!-- ================================================ -->
    <!-- Define Shell Executor -->
    <bean name="ShellExecutor"
        class="org.mobicents.ss7.ShellExecutor">
        <property name="address">${jboss.bind.address}</property>
        <property name="port">3435</property>
        <property name="linksetExecutor">
            <inject bean="LinksetExecutor" />
        </property>
        <!-- M3UAShellExecutor required only if M3UALinkset will be created. -->
        <property name="m3UAShellExecutor">
            <inject bean="M3UAShellExecutor" />
        </property>
        <property name="ruleExecutor">
            <inject bean="RuleExecutor" />
        </property>
    </bean>

By default ShellExecutor listens at jboss.bind.address and port 3435. You may set the address property to any valid IP address that your host is assigned. The shell commands are exchanged over TCP/IP.

SS7Service acts as core engine binding all the components together. To get holistic view of SS7 Service look at Section 2.3, “SS7 Service”


        <!-- ================================================ -->
    <!-- Mobicents SS7 Service                                                -->
    <!-- ================================================ -->
    <bean name="SS7Service" class="org.mobicents.ss7.SS7Service">
        <annotation>@org.jboss.aop.microcontainer.aspects.jmx.JMX(name="org.mobicents.ss7:service=SS7Service",exposedInterface=org.mobicents.ss7.SS7ServiceMBean.class,registerDirectly=true)</annotation>
        <property name="jndiName">java:/mobicents/ss7/sccp</property>       
        <property name="routerImpl"><inject bean="RouterImpl" /></property>
        <property name="linksetManager"><inject bean="LinksetManager" /></property>
        <property name="shellExecutor"><inject bean="ShellExecutor" /></property>
        <!-- remSignalingGateway required only if M3UALinkset will be used to connect to remote Signalling Gateway -->
        <property name="remSignalingGateway"><inject bean="RemSignalingGateway" /></property>       
    </bean>

SS7 service creates new instance of SCCP stack and binds it to JNDI address java:/mobicents/ss7/sccp. The JNDI name can be configured to any valid JNDI name specific to your application.

Mobicents Signaling Gateway Binary doesn't require any additional steps. You may copy mobicents-sgw to any folder of your choice.

In the Linux terminal or Windows command prompt, the Mobicents Signaling Gateway has started successfully if the last line of output is similar to the following

15:51:18,247 INFO  [MainDeployer] [[[[[[[[[ Mobicents Signaling Gateway: release.version=1.0.0.BETA8 Started ]]]]]]]]]

Configuration is done through an XML descriptor named sgw-beans.xml and is located at mobicents-sgw/deploy,

Mobicents SS7 Stack is an open source project, instructions for building from source are part of the manual! Building from source means you can stay on top with the latest features. Whilst aspects of Mobicents SS7 Stack are quite complicated, you may find ways to become contributors.

Mobicents SS7 Stack works with JDK1.5 and above (If using M3UA, JDK1.7 and above ). you will need also need to have the following tools installed. Minimum requirement version numbers provided.

  1. Downloading the source code

    Use SVN to checkout a specific release source, the base URL is http://mobicents.googlecode.com/svn/tags/protocols/ss7, then add the specific release version, lets consider 1.0.0.BETA8.

    [usr]$ svn co http://mobicents.googlecode.com/svn/tags/protocols/ss7/ss7-1.0.0.BETA8
  2. Building the source code

    Now that we have the source the next step is to build and install the source. Mobicents SS7 Stack uses Maven 2 to build the system. There are three profiles. Default one builds only java source. The other two profiles available "dahdilinux" and "dialogiclinux" additionaly compile native modules.

    Use "dahdilinux" profile if linux server on which this code is built already has dahdi module installed. Make sure you pass "include.zap" system property pointing to correct directory where dahdi is installed

    [usr]$ cd ss7-1.0.0.BETA8
    [usr]$ mvn install -Pdahdilinux -Dinclude.zap=/usr/include/dahdi
    				    

    Use "dialogiclinux" profile if linux server on which this code is built already has dialogic module installed. Make sure you pass "include.dialogic" system property pointing to correct directory where dialogic libraries are installed

    [usr]$ cd ss7-1.0.0.BETA8
    [usr]$ mvn install -Pdialogclinux -Dinclude.dialogic=/usr/include/dialogic
    				    

    To build Mobicents SS7 Stack without building any native libraries use

    [usr]$ cd ss7-1.0.0.BETA8
    [usr]$ mvn install 
    				    

    Use Ant to build the binary .

    [usr]$ cd ss7-1.0.0.BETA8/release
    [usr]$ ant
    				    

Similar process as for Section 3.8.1, “Release Source Code Building”, the only change is the SVN source code URL, which is http://mobicents.googlecode.com/svn/trunk/protocols/ss7.